'\" t
.\"     Title: ndb_mgmd
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 11/26/2022
.\"    Manual: MySQL Database System
.\"    Source: MySQL 8.0
.\"  Language: English
.\"
.TH "NDB_MGMD" "8" "11/26/2022" "MySQL 8\&.0" "MySQL Database System"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ndb_mgmd \- the NDB Cluster management server daemon
.SH "SYNOPSIS"
.HP \w'\fBndb_mgmd\ \fR\fB\fIoptions\fR\fR\ 'u
\fBndb_mgmd \fR\fB\fIoptions\fR\fR
.SH "DESCRIPTION"
.PP
The management server is the process that reads the cluster configuration file and distributes this information to all nodes in the cluster that request it\&. It also maintains a log of cluster activities\&. Management clients can connect to the management server and check the cluster\*(Aqs status\&.
.PP
All options that can be used with
\fBndb_mgmd\fR
are shown in the following table\&. Additional descriptions follow the table\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&23.26.\ \&Command\-line options used with the program ndb_mgmd
.TS
allbox tab(:);
lB lB lB.
T{
Format
T}:T{
Description
T}:T{
Added, Deprecated, or Removed
T}
.T&
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l
lB l l.
T{
.PP
\fB \fR\fB--bind-address=host\fR\fB \fR
T}:T{
Local bind address
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--character-sets-dir=path\fR\fB \fR
T}:T{
Directory containing character sets
T}:T{
.PP
REMOVED: 8.0.31
T}
T{
.PP
\fB \fR\fB--cluster-config-suffix=name\fR\fB \fR
T}:T{
Override defaults group suffix when reading cluster_config sections in
              my.cnf file; used in testing
T}:T{
.PP
ADDED: NDB 8.0.24
T}
T{
.PP
\fB \fR\fB--config-cache[=TRUE|FALSE]\fR\fB \fR
T}:T{
Enable management server configuration cache; true by default
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--config-file=file\fR,
.PP
\fB \fR\fB-f file\fR\fB \fR
T}:T{
Specify cluster configuration file; also specify --reload or --initial
              to override configuration cache if present
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--configdir=directory\fR,
.PP
\fB \fR\fB--config-dir=directory\fR\fB \fR
T}:T{
Specify cluster management server configuration cache directory
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--connect-retries=#\fR\fB \fR
T}:T{
Number of times to retry connection before giving up
T}:T{
.PP
REMOVED: 8.0.31
T}
T{
.PP
\fB \fR\fB--connect-retry-delay=#\fR\fB \fR
T}:T{
Number of seconds to wait between attempts to contact management server
T}:T{
.PP
REMOVED: 8.0.31
T}
T{
.PP
\fB--connect-string=connection_string\fR,
.PP
\fB \fR\fB-c connection_string\fR\fB \fR
T}:T{
Same as --ndb-connectstring
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--core-file\fR\fB \fR
T}:T{
Write core file on error; used in debugging
T}:T{
.PP
REMOVED: 8.0.31
T}
T{
.PP
\fB--daemon\fR,
.PP
\fB \fR\fB-d\fR\fB \fR
T}:T{
Run ndb_mgmd in daemon mode (default)
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--defaults-extra-file=path\fR\fB \fR
T}:T{
Read given file after global files are read
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--defaults-file=path\fR\fB \fR
T}:T{
Read default options from given file only
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--defaults-group-suffix=string\fR\fB \fR
T}:T{
Also read groups with concat(group, suffix)
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--help\fR,
.PP
\fB \fR\fB-?\fR\fB \fR
T}:T{
Display help text and exit
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--initial\fR\fB \fR
T}:T{
Causes management server to reload configuration data from configuration
              file, bypassing configuration cache
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--install[=name]\fR\fB \fR
T}:T{
Used to install management server process as Windows service; does not
              apply on other platforms
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--interactive\fR\fB \fR
T}:T{
Run ndb_mgmd in interactive mode (not officially supported in
              production; for testing purposes only)
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--log-name=name\fR\fB \fR
T}:T{
Name to use when writing cluster log messages applying to this node
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--login-path=path\fR\fB \fR
T}:T{
Read given path from login file
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--mycnf\fR\fB \fR
T}:T{
Read cluster configuration data from my.cnf file
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--ndb-connectstring=connection_string\fR,
.PP
\fB \fR\fB-c connection_string\fR\fB \fR
T}:T{
Set connect string for connecting to ndb_mgmd. Syntax:
              "[nodeid=id;][host=]hostname[:port]". Overrides entries in
              NDB_CONNECTSTRING and my.cnf
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--ndb-mgmd-host=connection_string\fR,
.PP
\fB \fR\fB-c connection_string\fR\fB \fR
T}:T{
Same as --ndb-connectstring
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--ndb-nodeid=#\fR\fB \fR
T}:T{
Set node ID for this node, overriding any ID set by --ndb-connectstring
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--ndb-optimized-node-selection\fR\fB \fR
T}:T{
Enable optimizations for selection of nodes for transactions. Enabled by
              default; use --skip-ndb-optimized-node-selection to
              disable
T}:T{
.PP
REMOVED: 8.0.31
T}
T{
.PP
\fB \fR\fB--no-defaults\fR\fB \fR
T}:T{
Do not read default options from any option file other than login file
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--no-nodeid-checks\fR\fB \fR
T}:T{
Do not perform any node ID checks
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--nodaemon\fR\fB \fR
T}:T{
Do not run ndb_mgmd as a daemon
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--nowait-nodes=list\fR\fB \fR
T}:T{
Do not wait for management nodes specified when starting this management
              server; requires --ndb-nodeid option
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--print-defaults\fR\fB \fR
T}:T{
Print program argument list and exit
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--print-full-config\fR,
.PP
\fB \fR\fB-P\fR\fB \fR
T}:T{
Print full configuration and exit
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--reload\fR\fB \fR
T}:T{
Causes management server to compare configuration file with
              configuration cache
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--remove[=name]\fR\fB \fR
T}:T{
Used to remove management server process that was previously installed
              as Windows service, optionally specifying name of service
              to be removed; does not apply on other platforms
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--usage\fR,
.PP
\fB \fR\fB-?\fR\fB \fR
T}:T{
Display help text and exit; same as --help
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB \fR\fB--skip-config-file\fR\fB \fR
T}:T{
Do not use configuration file
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--verbose\fR,
.PP
\fB \fR\fB-v\fR\fB \fR
T}:T{
Write additional information to log
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
T{
.PP
\fB--version\fR,
.PP
\fB \fR\fB-V\fR\fB \fR
T}:T{
Display version information and exit
T}:T{
.PP
(Supported in all NDB releases based on MySQL 8.0)
T}
.TE
.sp 1
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-bind\-address=\fR\fB\fIhost\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--bind-address=host
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Causes the management server to bind to a specific network interface (host name or IP address)\&. This option has no default value\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-character\-sets\-dir\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--character-sets-dir=path
T}
T{
Removed
T}:T{
8.0.31
T}
.TE
.sp 1
Directory containing character sets\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fBcluster\-config\-suffix\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--cluster-config-suffix=name
T}
T{
Introduced
T}:T{
8.0.24-ndb-8.0.24
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Override defaults group suffix when reading cluster configuration sections in
my\&.cnf; used in testing\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-config\-cache\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--config-cache[=TRUE|FALSE]
T}
T{
Type
T}:T{
Boolean
T}
T{
Default Value
T}:T{
TRUE
T}
.TE
.sp 1
This option, whose default value is
1
(or
TRUE, or
ON), can be used to disable the management server\*(Aqs configuration cache, so that it reads its configuration from
config\&.ini
every time it starts (see
Section\ \&23.4.3, \(lqNDB Cluster Configuration Files\(rq)\&. You can do this by starting the
\fBndb_mgmd\fR
process with any one of the following options:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-config\-cache=0\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-config\-cache=FALSE\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-config\-cache=OFF\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-skip\-config\-cache\fR
.RE
.sp
Using one of the options just listed is effective only if the management server has no stored configuration at the time it is started\&. If the management server finds any configuration cache files, then the
\fB\-\-config\-cache\fR
option or the
\fB\-\-skip\-config\-cache\fR
option is ignored\&. Therefore, to disable configuration caching, the option should be used the
\fIfirst\fR
time that the management server is started\&. Otherwise\(emthat is, if you wish to disable configuration caching for a management server that has
\fIalready\fR
created a configuration cache\(emyou must stop the management server, delete any existing configuration cache files manually, then restart the management server with
\fB\-\-skip\-config\-cache\fR
(or with
\fB\-\-config\-cache\fR
set equal to 0,
OFF, or
FALSE)\&.
.sp
Configuration cache files are normally created in a directory named
mysql\-cluster
under the installation directory (unless this location has been overridden using the
\fB\-\-configdir\fR
option)\&. Each time the management server updates its configuration data, it writes a new cache file\&. The files are named sequentially in order of creation using the following format:
.sp
.if n \{\
.RS 4
.\}
.nf
ndb_\fInode\-id\fR_config\&.bin\&.\fIseq\-number\fR
.fi
.if n \{\
.RE
.\}
.sp
\fInode\-id\fR
is the management server\*(Aqs node ID;
\fIseq\-number\fR
is a sequence number, beginning with 1\&. For example, if the management server\*(Aqs node ID is 5, then the first three configuration cache files would, when they are created, be named
ndb_5_config\&.bin\&.1,
ndb_5_config\&.bin\&.2, and
ndb_5_config\&.bin\&.3\&.
.sp
If your intent is to purge or reload the configuration cache without actually disabling caching, you should start
\fBndb_mgmd\fR
with one of the options
\fB\-\-reload\fR
or
\fB\-\-initial\fR
instead of
\fB\-\-skip\-config\-cache\fR\&.
.sp
To re\-enable the configuration cache, simply restart the management server, but without the
\fB\-\-config\-cache\fR
or
\fB\-\-skip\-config\-cache\fR
option that was used previously to disable the configuration cache\&.
.sp
\fBndb_mgmd\fR
does not check for the configuration directory (\fB\-\-configdir\fR) or attempts to create one when
\fB\-\-skip\-config\-cache\fR
is used\&. (Bug #13428853)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-config\-file=\fR\fB\fIfilename\fR\fR,
\fB\-f \fR\fB\fIfilename\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--config-file=file
T}
T{
Disabled by
T}:T{
skip-config-file
T}
T{
Type
T}:T{
File name
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Instructs the management server as to which file it should use for its configuration file\&. By default, the management server looks for a file named
config\&.ini
in the same directory as the
\fBndb_mgmd\fR
executable; otherwise the file name and location must be specified explicitly\&.
.sp
This option has no default value, and is ignored unless the management server is forced to read the configuration file, either because
\fBndb_mgmd\fR
was started with the
\fB\-\-reload\fR
or
\fB\-\-initial\fR
option, or because the management server could not find any configuration cache\&. Beginning with NDB 8\&.0\&.26,
\fBndb_mgmd\fR
refuses to start if
\fB\-\-config\-file\fR
is specified without either of
\fB\-\-initial\fR
or
\fB\-\-reload\fR\&.
.sp
The
\fB\-\-config\-file\fR
option is also read if
\fBndb_mgmd\fR
was started with
\fB\-\-config\-cache=OFF\fR\&. See
Section\ \&23.4.3, \(lqNDB Cluster Configuration Files\(rq, for more information\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-configdir=\fR\fB\fIdir_name\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
.PP
--configdir=directory
.PP
--config-dir=directory
T}
T{
Type
T}:T{
File name
T}
T{
Default Value
T}:T{
$INSTALLDIR/mysql-cluster
T}
.TE
.sp 1
Specifies the cluster management server\*(Aqs configuration cache directory\&.
\fB\-\-config\-dir\fR
is an alias for this option\&.
.sp
In NDB 8\&.0\&.27 and later, this must be an absolute path\&. Otherwise, the management server refuses to start\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-connect\-retries\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--connect-retries=#
T}
T{
Removed
T}:T{
8.0.31
T}
T{
Type
T}:T{
Integer
T}
T{
Default Value
T}:T{
12
T}
T{
Minimum Value
T}:T{
0
T}
T{
Maximum Value
T}:T{
12
T}
.TE
.sp 1
Number of times to retry connection before giving up\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-connect\-retry\-delay\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--connect-retry-delay=#
T}
T{
Removed
T}:T{
8.0.31
T}
T{
Type
T}:T{
Integer
T}
T{
Default Value
T}:T{
5
T}
T{
Minimum Value
T}:T{
0
T}
T{
Maximum Value
T}:T{
5
T}
.TE
.sp 1
Number of seconds to wait between attempts to contact management server\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-connect\-string\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--connect-string=connection_string
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Same as \-\-ndb\-connectstring\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-core\-file\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--core-file
T}
T{
Removed
T}:T{
8.0.31
T}
.TE
.sp 1
Write core file on error; used in debugging\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-daemon\fR,
\fB\-d\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--daemon
T}
.TE
.sp 1
Instructs
\fBndb_mgmd\fR
to start as a daemon process\&. This is the default behavior\&.
.sp
This option has no effect when running
\fBndb_mgmd\fR
on Windows platforms\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-defaults\-extra\-file\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--defaults-extra-file=path
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Read given file after global files are read\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-defaults\-file\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--defaults-file=path
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Read default options from given file only\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-defaults\-group\-suffix\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--defaults-group-suffix=string
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Also read groups with concat(group, suffix)\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-help\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--help
T}
.TE
.sp 1
Display help text and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-initial\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--initial
T}
.TE
.sp 1
Configuration data is cached internally, rather than being read from the cluster global configuration file each time the management server is started (see
Section\ \&23.4.3, \(lqNDB Cluster Configuration Files\(rq)\&. Using the
\fB\-\-initial\fR
option overrides this behavior, by forcing the management server to delete any existing cache files, and then to re\-read the configuration data from the cluster configuration file and to build a new cache\&.
.sp
This differs in two ways from the
\fB\-\-reload\fR
option\&. First,
\fB\-\-reload\fR
forces the server to check the configuration file against the cache and reload its data only if the contents of the file are different from the cache\&. Second,
\fB\-\-reload\fR
does not delete any existing cache files\&.
.sp
If
\fBndb_mgmd\fR
is invoked with
\fB\-\-initial\fR
but cannot find a global configuration file, the management server cannot start\&.
.sp
When a management server starts, it checks for another management server in the same NDB Cluster and tries to use the other management server\*(Aqs configuration data\&. This behavior has implications when performing a rolling restart of an NDB Cluster with multiple management nodes\&. See
Section\ \&23.6.5, \(lqPerforming a Rolling Restart of an NDB Cluster\(rq, for more information\&.
.sp
When used together with the
\fB\-\-config\-file\fR
option, the cache is cleared only if the configuration file is actually found\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-install[=\fR\fB\fIname\fR\fR\fB]\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--install[=name]
T}
T{
Platform Specific
T}:T{
Windows
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
ndb_mgmd
T}
.TE
.sp 1
Causes
\fBndb_mgmd\fR
to be installed as a Windows service\&. Optionally, you can specify a name for the service; if not set, the service name defaults to
ndb_mgmd\&. Although it is preferable to specify other
\fBndb_mgmd\fR
program options in a
my\&.ini
or
my\&.cnf
configuration file, it is possible to use them together with
\fB\-\-install\fR\&. However, in such cases, the
\fB\-\-install\fR
option must be specified first, before any other options are given, for the Windows service installation to succeed\&.
.sp
It is generally not advisable to use this option together with the
\fB\-\-initial\fR
option, since this causes the configuration cache to be wiped and rebuilt every time the service is stopped and started\&. Care should also be taken if you intend to use any other
\fBndb_mgmd\fR
options that affect the starting of the management server, and you should make absolutely certain you fully understand and allow for any possible consequences of doing so\&.
.sp
The
\fB\-\-install\fR
option has no effect on non\-Windows platforms\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-interactive\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--interactive
T}
.TE
.sp 1
Starts
\fBndb_mgmd\fR
in interactive mode; that is, an
\fBndb_mgm\fR
client session is started as soon as the management server is running\&. This option does not start any other NDB Cluster nodes\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-log\-name=\fR\fB\fIname\fR\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--log-name=name
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
MgmtSrvr
T}
.TE
.sp 1
Provides a name to be used for this node in the cluster log\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-login\-path\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--login-path=path
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Read given path from login file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-mycnf\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--mycnf
T}
.TE
.sp 1
Read configuration data from the
my\&.cnf
file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-ndb\-connectstring\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--ndb-connectstring=connection_string
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Set connection string\&. Syntax:
[nodeid=\fIid\fR;][host=]\fIhostname\fR[:\fIport\fR]\&. Overrides entries in
NDB_CONNECTSTRING
and
my\&.cnf\&. Ignored if
\fB\-\-config\-file\fR
is specified; beginning with NDB 8\&.0\&.27, a warning is issued when both options are used\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-ndb\-mgmd\-host\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--ndb-mgmd-host=connection_string
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Same as \-\-ndb\-connectstring\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-ndb\-nodeid\fR
.TS
allbox tab(:);
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--ndb-nodeid=#
T}
T{
Type
T}:T{
Integer
T}
T{
Default Value
T}:T{
[none]
T}
.TE
.sp 1
Set node ID for this node, overriding any ID set by \-\-ndb\-connectstring\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-ndb\-optimized\-node\-selection\fR
.TS
allbox tab(:);
lB l
lB l.
T{
Command-Line Format
T}:T{
--ndb-optimized-node-selection
T}
T{
Removed
T}:T{
8.0.31
T}
.TE
.sp 1
Enable optimizations for selection of nodes for transactions\&. Enabled by default; use
\fB\-\-skip\-ndb\-optimized\-node\-selection\fR
to disable\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-no\-nodeid\-checks\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--no-nodeid-checks
T}
.TE
.sp 1
Do not perform any checks of node IDs\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-nodaemon\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--nodaemon
T}
.TE
.sp 1
Instructs
\fBndb_mgmd\fR
not to start as a daemon process\&.
.sp
The default behavior for
\fBndb_mgmd\fR
on Windows is to run in the foreground, making this option unnecessary on Windows platforms\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-no\-defaults\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--no-defaults
T}
.TE
.sp 1
Do not read default options from any option file other than login file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-nowait\-nodes\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--nowait-nodes=list
T}
T{
Type
T}:T{
Numeric
T}
T{
Default Value
T}:T{
[none]
T}
T{
Minimum Value
T}:T{
1
T}
T{
Maximum Value
T}:T{
255
T}
.TE
.sp 1
When starting an NDB Cluster is configured with two management nodes, each management server normally checks to see whether the other
\fBndb_mgmd\fR
is also operational and whether the other management server\*(Aqs configuration is identical to its own\&. However, it is sometimes desirable to start the cluster with only one management node (and perhaps to allow the other
\fBndb_mgmd\fR
to be started later)\&. This option causes the management node to bypass any checks for any other management nodes whose node IDs are passed to this option, permitting the cluster to start as though configured to use only the management node that was started\&.
.sp
For purposes of illustration, consider the following portion of a
config\&.ini
file (where we have omitted most of the configuration parameters that are not relevant to this example):
.sp
.if n \{\
.RS 4
.\}
.nf
[ndbd]
NodeId = 1
HostName = 198\&.51\&.100\&.101
[ndbd]
NodeId = 2
HostName = 198\&.51\&.100\&.102
[ndbd]
NodeId = 3
HostName = 198\&.51\&.100\&.103
[ndbd]
NodeId = 4
HostName = 198\&.51\&.100\&.104
[ndb_mgmd]
NodeId = 10
HostName = 198\&.51\&.100\&.150
[ndb_mgmd]
NodeId = 11
HostName = 198\&.51\&.100\&.151
[api]
NodeId = 20
HostName = 198\&.51\&.100\&.200
[api]
NodeId = 21
HostName = 198\&.51\&.100\&.201
.fi
.if n \{\
.RE
.\}
.sp
Assume that you wish to start this cluster using only the management server having node ID
10
and running on the host having the IP address 198\&.51\&.100\&.150\&. (Suppose, for example, that the host computer on which you intend to the other management server is temporarily unavailable due to a hardware failure, and you are waiting for it to be repaired\&.) To start the cluster in this way, use a command line on the machine at 198\&.51\&.100\&.150 to enter the following command:
.sp
.if n \{\
.RS 4
.\}
.nf
$> \fBndb_mgmd \-\-ndb\-nodeid=10 \-\-nowait\-nodes=11\fR
.fi
.if n \{\
.RE
.\}
.sp
As shown in the preceding example, when using
\fB\-\-nowait\-nodes\fR, you must also use the
\fB\-\-ndb\-nodeid\fR
option to specify the node ID of this
\fBndb_mgmd\fR
process\&.
.sp
You can then start each of the cluster\*(Aqs data nodes in the usual way\&. If you wish to start and use the second management server in addition to the first management server at a later time without restarting the data nodes, you must start each data node with a connection string that references both management servers, like this:
.sp
.if n \{\
.RS 4
.\}
.nf
$> \fBndbd \-c 198\&.51\&.100\&.150,198\&.51\&.100\&.151\fR
.fi
.if n \{\
.RE
.\}
.sp
The same is true with regard to the connection string used with any
\fBmysqld\fR
processes that you wish to start as NDB Cluster SQL nodes connected to this cluster\&. See
Section\ \&23.4.3.3, \(lqNDB Cluster Connection Strings\(rq, for more information\&.
.sp
When used with
\fBndb_mgmd\fR, this option affects the behavior of the management node with regard to other management nodes only\&. Do not confuse it with the
\fB\-\-nowait\-nodes\fR
option used with
\fBndbd\fR
or
\fBndbmtd\fR
to permit a cluster to start with fewer than its full complement of data nodes; when used with data nodes, this option affects their behavior only with regard to other data nodes\&.
.sp
Multiple management node IDs may be passed to this option as a comma\-separated list\&. Each node ID must be no less than 1 and no greater than 255\&. In practice, it is quite rare to use more than two management servers for the same NDB Cluster (or to have any need for doing so); in most cases you need to pass to this option only the single node ID for the one management server that you do not wish to use when starting the cluster\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
When you later start the
\(lqmissing\(rq
management server, its configuration must match that of the management server that is already in use by the cluster\&. Otherwise, it fails the configuration check performed by the existing management server, and does not start\&.
.sp .5v
.RE
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-print\-defaults\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--print-defaults
T}
.TE
.sp 1
Print program argument list and exit\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-print\-full\-config\fR,
\fB\-P\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--print-full-config
T}
.TE
.sp 1
Shows extended information regarding the configuration of the cluster\&. With this option on the command line the
\fBndb_mgmd\fR
process prints information about the cluster setup including an extensive list of the cluster configuration sections as well as parameters and their values\&. Normally used together with the
\fB\-\-config\-file\fR
(\fB\-f\fR) option\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-reload\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--reload
T}
.TE
.sp 1
NDB Cluster configuration data is stored internally rather than being read from the cluster global configuration file each time the management server is started (see
Section\ \&23.4.3, \(lqNDB Cluster Configuration Files\(rq)\&. Using this option forces the management server to check its internal data store against the cluster configuration file and to reload the configuration if it finds that the configuration file does not match the cache\&. Existing configuration cache files are preserved, but not used\&.
.sp
This differs in two ways from the
\fB\-\-initial\fR
option\&. First,
\fB\-\-initial\fR
causes all cache files to be deleted\&. Second,
\fB\-\-initial\fR
forces the management server to re\-read the global configuration file and construct a new cache\&.
.sp
If the management server cannot find a global configuration file, then the
\fB\-\-reload\fR
option is ignored\&.
.sp
When
\fB\-\-reload\fR
is used, the management server must be able to communicate with data nodes and any other management servers in the cluster before it attempts to read the global configuration file; otherwise, the management server fails to start\&. This can happen due to changes in the networking environment, such as new IP addresses for nodes or an altered firewall configuration\&. In such cases, you must use
\fB\-\-initial\fR
instead to force the existing cached configuration to be discarded and reloaded from the file\&. See
Section\ \&23.6.5, \(lqPerforming a Rolling Restart of an NDB Cluster\(rq, for additional information\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-remove[=name]\fR
.TS
allbox tab(:);
lB l
lB l
lB l
lB l.
T{
Command-Line Format
T}:T{
--remove[=name]
T}
T{
Platform Specific
T}:T{
Windows
T}
T{
Type
T}:T{
String
T}
T{
Default Value
T}:T{
ndb_mgmd
T}
.TE
.sp 1
Remove a management server process that has been installed as a Windows service, optionally specifying the name of the service to be removed\&. Applies only to Windows platforms\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-skip\-config\-file\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--skip-config-file
T}
.TE
.sp 1
Do not read cluster configuration file; ignore
\fB\-\-initial\fR
and
\fB\-\-reload\fR
options if specified\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-usage\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--usage
T}
.TE
.sp 1
Display help text and exit; same as \-\-help\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-verbose\fR,
\fB\-v\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--verbose
T}
.TE
.sp 1
Remove a management server process that has been installed as a Windows service, optionally specifying the name of the service to be removed\&. Applies only to Windows platforms\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\fB\-\-version\fR
.TS
allbox tab(:);
lB l.
T{
Command-Line Format
T}:T{
--version
T}
.TE
.sp 1
Display version information and exit\&.
.RE
.PP
It is not strictly necessary to specify a connection string when starting the management server\&. However, if you are using more than one management server, a connection string should be provided and each node in the cluster should specify its node ID explicitly\&.
.PP
See
Section\ \&23.4.3.3, \(lqNDB Cluster Connection Strings\(rq, for information about using connection strings\&.
ndb_mgmd(8), describes other options for
\fBndb_mgmd\fR\&.
.PP
The following files are created or used by
\fBndb_mgmd\fR
in its starting directory, and are placed in the
DataDir
as specified in the
config\&.ini
configuration file\&. In the list that follows,
\fInode_id\fR
is the unique node identifier\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
config\&.ini
is the configuration file for the cluster as a whole\&. This file is created by the user and read by the management server\&.
Section\ \&23.4, \(lqConfiguration of NDB Cluster\(rq, discusses how to set up this file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ndb_\fInode_id\fR_cluster\&.log
is the cluster events log file\&. Examples of such events include checkpoint startup and completion, node startup events, node failures, and levels of memory usage\&. A complete listing of cluster events with descriptions may be found in
Section\ \&23.6, \(lqManagement of NDB Cluster\(rq\&.
.sp
By default, when the size of the cluster log reaches one million bytes, the file is renamed to
ndb_\fInode_id\fR_cluster\&.log\&.\fIseq_id\fR, where
\fIseq_id\fR
is the sequence number of the cluster log file\&. (For example: If files with the sequence numbers 1, 2, and 3 already exist, the next log file is named using the number
4\&.) You can change the size and number of files, and other characteristics of the cluster log, using the
LogDestination
configuration parameter\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ndb_\fInode_id\fR_out\&.log
is the file used for
stdout
and
stderr
when running the management server as a daemon\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ndb_\fInode_id\fR\&.pid
is the process ID file used when running the management server as a daemon\&.
.RE
.SH "COPYRIGHT"
.br
.PP
Copyright \(co 1997, 2022, Oracle and/or its affiliates.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
.sp
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
which may already be installed locally and which is also available
online at http://dev.mysql.com/doc/.
.SH AUTHOR
Oracle Corporation (http://dev.mysql.com/).
